package com.xci.platform.auth.dao;

import com.xci.platform.auth.entity.DocEntity;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.List;
import java.util.Map;

/**
 * 系统文档数据访问接口
 */
@Mapper
public interface DocDao {

    /**
     * 新增文档
     *
     * @param entity 文档对象
     * @return 返回影响的行数
     */
    Integer insert(@Param("entity") DocEntity entity);

    /**
     * 更新文档
     *
     * @param entity 文档对象
     * @return 返回影响的行数
     */
    Integer update(@Param("entity") DocEntity entity);

    /**
     * 删除文档
     *
     * @param id 文档主键
     * @return 返回影响的行数
     */
    Integer delete(@Param("id") String id);

    /**
     * 更新文档启用状态
     *
     * @param id     文档主键
     * @param status 是否启用(1:启用 0:禁用)
     */
    Integer updateStatus(@Param("id") String id,
                         @Param("status") Integer status);

    /**
     * 根据文档主键获取文档对象
     *
     * @param id 文档主键
     * @return 返回指定文档主键的文档对象
     */
    DocEntity queryById(@Param("id") String id);

    /**
     * 查询文档列表
     *
     * @param params 查询参数
     * @return 返回符合查询条件的文档列表
     */
    List<DocEntity> query(Map params);
}
